<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>CachingReflectionHelper xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/googlecode/ehcache/annotations/key/CachingReflectionHelper.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright (c) 2000-2009, Jasig, Inc.</em>
<a name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * See license distributed with this file and available online at</em>
<a name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * https://www.ja-sig.org/svn/jasig-parent/tags/rel-10/license-header.txt</em>
<a name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> */</em>
<a name="6" href="#6">6</a>   
<a name="7" href="#7">7</a>   <strong class="jxr_keyword">package</strong> com.googlecode.ehcache.annotations.key;
<a name="8" href="#8">8</a>   
<a name="9" href="#9">9</a>   <strong class="jxr_keyword">import</strong> java.lang.ref.Reference;
<a name="10" href="#10">10</a>  <strong class="jxr_keyword">import</strong> java.lang.ref.ReferenceQueue;
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.Method;
<a name="12" href="#12">12</a>  <strong class="jxr_keyword">import</strong> java.util.EnumSet;
<a name="13" href="#13">13</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> java.util.Set;
<a name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.atomic.AtomicBoolean;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.DisposableBean;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.springframework.util.ReflectionUtils;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> org.springframework.util.ReflectionUtils.MethodCallback;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.util.guice.FinalizableReference;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.util.guice.ReferenceMap;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.util.guice.ReferenceType;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment">/**</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * {@link ReflectionHelper} that uses a cache to track reflection operations. A background thread is started on first</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * usage to perform cache cleanup to avoid class reference leaks. Code that uses this class should call {@link #destroy()}</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * when complete to ensure the cleanup thread shuts down.  </em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * </em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * @author Eric Dalquist</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * @version $Revision: 464 $</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> */</em>
<a name="36" href="#36">36</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/CachingReflectionHelper.html">CachingReflectionHelper</a> implements DisposableBean, <a href="../../../../../com/googlecode/ehcache/annotations/key/ReflectionHelper.html">ReflectionHelper</a> {
<a name="37" href="#37">37</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> Logger logger = LoggerFactory.getLogger(<strong class="jxr_keyword">this</strong>.getClass());
<a name="38" href="#38">38</a>      
<a name="39" href="#39">39</a>      <strong class="jxr_keyword">private</strong> enum <a href="../../../../../com/googlecode/ehcache/annotations/key/CachingReflectionHelper.html">ImplementsMethod</a> {
<a name="40" href="#40">40</a>          HASH_CODE,
<a name="41" href="#41">41</a>          EQUALS,
<a name="42" href="#42">42</a>          TO_STRING;
<a name="43" href="#43">43</a>      }
<a name="44" href="#44">44</a>      
<a name="45" href="#45">45</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ReferenceQueue&lt;Object&gt; referenceQueue = <strong class="jxr_keyword">new</strong> ReferenceQueue&lt;Object&gt;();
<a name="46" href="#46">46</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;Class&lt;?&gt;, Set&lt;ImplementsMethod&gt;&gt; implementsCache = <strong class="jxr_keyword">new</strong> ReferenceMap&lt;Class&lt;?&gt;, Set&lt;ImplementsMethod&gt;&gt;(ReferenceType.WEAK, ReferenceType.STRONG, <strong class="jxr_keyword">this</strong>.referenceQueue);
<a name="47" href="#47">47</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Thread cleanupThread;
<a name="48" href="#48">48</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> AtomicBoolean running = <strong class="jxr_keyword">new</strong> AtomicBoolean(false);
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/CachingReflectionHelper.html">CachingReflectionHelper</a>() {
<a name="51" href="#51">51</a>          <strong class="jxr_keyword">this</strong>.cleanupThread = <strong class="jxr_keyword">new</strong> Thread(<span class="jxr_string">"CachingReflectionHelper_CleanupThread"</span>) {
<a name="52" href="#52">52</a>              @Override
<a name="53" href="#53">53</a>              <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run() {
<a name="54" href="#54">54</a>                  <strong class="jxr_keyword">while</strong> (running.get()) {
<a name="55" href="#55">55</a>                      <strong class="jxr_keyword">try</strong> {
<a name="56" href="#56">56</a>                          <strong class="jxr_keyword">final</strong> Reference&lt;? <strong class="jxr_keyword">extends</strong> Object&gt; reference = referenceQueue.remove();
<a name="57" href="#57">57</a>                          ((<a href="../../../../../com/googlecode/ehcache/annotations/util/guice/FinalizableReference.html">FinalizableReference</a>) reference).finalizeReferent();
<a name="58" href="#58">58</a>                      }
<a name="59" href="#59">59</a>                      <strong class="jxr_keyword">catch</strong> (InterruptedException e) {
<a name="60" href="#60">60</a>                          <em class="jxr_comment">/*<em class="jxr_comment"> ignore */</em></em>
<a name="61" href="#61">61</a>                      }
<a name="62" href="#62">62</a>                      <strong class="jxr_keyword">catch</strong> (Throwable t) {
<a name="63" href="#63">63</a>                          logger.error(<span class="jxr_string">"Error finalizing reference."</span>, t);
<a name="64" href="#64">64</a>                      }
<a name="65" href="#65">65</a>                  }
<a name="66" href="#66">66</a>              }
<a name="67" href="#67">67</a>          };
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>          <strong class="jxr_keyword">this</strong>.cleanupThread.setDaemon(<strong class="jxr_keyword">true</strong>);
<a name="70" href="#70">70</a>      }
<a name="71" href="#71">71</a>      
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setThreadName(String threadName) {
<a name="74" href="#74">74</a>          <strong class="jxr_keyword">this</strong>.cleanupThread.setName(<span class="jxr_string">"CachingReflectionHelper_CleanupThread"</span> + (threadName != <strong class="jxr_keyword">null</strong> ? <span class="jxr_string">"-"</span> + threadName : <span class="jxr_string">""</span>));
<a name="75" href="#75">75</a>      }
<a name="76" href="#76">76</a>  
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>      <strong class="jxr_keyword">private</strong> Map&lt;Class&lt;?&gt;, Set&lt;ImplementsMethod&gt;&gt; getCache() {
<a name="80" href="#80">80</a>          <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.running.get() &amp;&amp; <strong class="jxr_keyword">this</strong>.running.compareAndSet(false, <strong class="jxr_keyword">true</strong>)) {
<a name="81" href="#81">81</a>              <em class="jxr_comment">//Don't start the cleanup thread until the cache is actually accessed</em>
<a name="82" href="#82">82</a>              <strong class="jxr_keyword">this</strong>.cleanupThread.start();
<a name="83" href="#83">83</a>          }
<a name="84" href="#84">84</a>          
<a name="85" href="#85">85</a>          <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.implementsCache;
<a name="86" href="#86">86</a>      }
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>      @Override
<a name="89" href="#89">89</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> finalize() <strong class="jxr_keyword">throws</strong> Throwable {
<a name="90" href="#90">90</a>          <strong class="jxr_keyword">this</strong>.destroy();
<a name="91" href="#91">91</a>      }
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> destroy() <strong class="jxr_keyword">throws</strong> Exception {
<a name="94" href="#94">94</a>          <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.running.get() &amp;&amp; <strong class="jxr_keyword">this</strong>.running.compareAndSet(<strong class="jxr_keyword">true</strong>, false)) {
<a name="95" href="#95">95</a>              <strong class="jxr_keyword">this</strong>.cleanupThread.interrupt();
<a name="96" href="#96">96</a>              <strong class="jxr_keyword">try</strong> {
<a name="97" href="#97">97</a>                  <strong class="jxr_keyword">this</strong>.cleanupThread.join(1000);
<a name="98" href="#98">98</a>              }
<a name="99" href="#99">99</a>              <strong class="jxr_keyword">catch</strong> (InterruptedException e) {
<a name="100" href="#100">100</a>                 logger.warn(<span class="jxr_string">"Failed to join the "</span> + <strong class="jxr_keyword">this</strong>.cleanupThread.getName() + <span class="jxr_string">" thread"</span>);
<a name="101" href="#101">101</a>             }
<a name="102" href="#102">102</a>         }
<a name="103" href="#103">103</a>     }
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>     
<a name="106" href="#106">106</a>     <em class="jxr_comment">/*<em class="jxr_comment"> (non-Javadoc)</em></em>
<a name="107" href="#107">107</a> <em class="jxr_comment">     * @see com.googlecode.ehcache.annotations.util.guice.ReflectionHelper#implementsHashCode(java.lang.Object)</em>
<a name="108" href="#108">108</a> <em class="jxr_comment">     */</em>
<a name="109" href="#109">109</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> implementsHashCode(Object element) {
<a name="110" href="#110">110</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.doesImplement(element.getClass(), ImplementsMethod.HASH_CODE);
<a name="111" href="#111">111</a>     }
<a name="112" href="#112">112</a>     
<a name="113" href="#113">113</a>     <em class="jxr_comment">/*<em class="jxr_comment"> (non-Javadoc)</em></em>
<a name="114" href="#114">114</a> <em class="jxr_comment">     * @see com.googlecode.ehcache.annotations.util.guice.ReflectionHelper#implementsEquals(java.lang.Object)</em>
<a name="115" href="#115">115</a> <em class="jxr_comment">     */</em>
<a name="116" href="#116">116</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> implementsEquals(Object element) {
<a name="117" href="#117">117</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.doesImplement(element.getClass(), ImplementsMethod.EQUALS);
<a name="118" href="#118">118</a>     }
<a name="119" href="#119">119</a>     
<a name="120" href="#120">120</a>     <em class="jxr_comment">/*<em class="jxr_comment"> (non-Javadoc)</em></em>
<a name="121" href="#121">121</a> <em class="jxr_comment">     * @see com.googlecode.ehcache.annotations.util.guice.ReflectionHelper#implementsToString(java.lang.Object)</em>
<a name="122" href="#122">122</a> <em class="jxr_comment">     */</em>
<a name="123" href="#123">123</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> implementsToString(Object element) {
<a name="124" href="#124">124</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.doesImplement(element.getClass(), ImplementsMethod.TO_STRING);
<a name="125" href="#125">125</a>     }
<a name="126" href="#126">126</a>     
<a name="127" href="#127">127</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clearCache() {
<a name="128" href="#128">128</a>         <strong class="jxr_keyword">final</strong> Map&lt;Class&lt;?&gt;, Set&lt;ImplementsMethod&gt;&gt; cache = <strong class="jxr_keyword">this</strong>.getCache();
<a name="129" href="#129">129</a>         cache.clear();
<a name="130" href="#130">130</a>     }
<a name="131" href="#131">131</a>     
<a name="132" href="#132">132</a>     <em class="jxr_javadoccomment">/**</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     * Scans a class to see if it implements the hashCode, toString and equals methods which are commonly</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * used by key generators</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     */</em>
<a name="136" href="#136">136</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> doesImplement(<strong class="jxr_keyword">final</strong> Class&lt;?&gt; elementClass, <a href="../../../../../com/googlecode/ehcache/annotations/key/CachingReflectionHelper.html">ImplementsMethod</a> method) {
<a name="137" href="#137">137</a>         <strong class="jxr_keyword">final</strong> Map&lt;Class&lt;?&gt;, Set&lt;ImplementsMethod&gt;&gt; cache = <strong class="jxr_keyword">this</strong>.getCache();
<a name="138" href="#138">138</a>         Set&lt;ImplementsMethod&gt; methodCache = cache.get(elementClass);
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>         <strong class="jxr_keyword">if</strong> (methodCache == <strong class="jxr_keyword">null</strong>) {
<a name="141" href="#141">141</a>             methodCache = EnumSet.noneOf(ImplementsMethod.<strong class="jxr_keyword">class</strong>);
<a name="142" href="#142">142</a>             cache.put(elementClass, methodCache);
<a name="143" href="#143">143</a> 
<a name="144" href="#144">144</a>             <em class="jxr_comment">//Create final reference for use by anonymous class</em>
<a name="145" href="#145">145</a>             <strong class="jxr_keyword">final</strong> Set&lt;ImplementsMethod&gt; implementsSet = methodCache;
<a name="146" href="#146">146</a>             ReflectionUtils.doWithMethods(elementClass, <strong class="jxr_keyword">new</strong> MethodCallback() {
<a name="147" href="#147">147</a>                 <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doWith(Method method) <strong class="jxr_keyword">throws</strong> IllegalArgumentException, IllegalAccessException {
<a name="148" href="#148">148</a>                     <strong class="jxr_keyword">if</strong> (implementsSet.size() == 3 || method.getDeclaringClass() == Object.<strong class="jxr_keyword">class</strong>) {
<a name="149" href="#149">149</a>                         <strong class="jxr_keyword">return</strong>;
<a name="150" href="#150">150</a>                     }
<a name="151" href="#151">151</a>                     
<a name="152" href="#152">152</a>                     <strong class="jxr_keyword">if</strong> (ReflectionUtils.isEqualsMethod(method)) {
<a name="153" href="#153">153</a>                         implementsSet.add(ImplementsMethod.EQUALS);
<a name="154" href="#154">154</a>                     }
<a name="155" href="#155">155</a>                     <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (ReflectionUtils.isHashCodeMethod(method)) {
<a name="156" href="#156">156</a>                         implementsSet.add(ImplementsMethod.HASH_CODE);
<a name="157" href="#157">157</a>                     }
<a name="158" href="#158">158</a>                     <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (ReflectionUtils.isToStringMethod(method)) {
<a name="159" href="#159">159</a>                         implementsSet.add(ImplementsMethod.TO_STRING);
<a name="160" href="#160">160</a>                     }
<a name="161" href="#161">161</a>                 }
<a name="162" href="#162">162</a>             });
<a name="163" href="#163">163</a>         }
<a name="164" href="#164">164</a>         
<a name="165" href="#165">165</a>         <strong class="jxr_keyword">return</strong> methodCache.contains(method);
<a name="166" href="#166">166</a>     }
<a name="167" href="#167">167</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

